SynapseKeyCollection Class

Reference

Definition

Namespace:: Azure.ResourceManager.Synapse

Assembly:: Azure.ResourceManager.Synapse.dll

Package:: Azure.ResourceManager.Synapse v1.2.0

Package:: Azure.ResourceManager.Synapse v1.2.0-beta.1

Source:: SynapseKeyCollection.cs

Source:: SynapseKeyCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A class representing a collection of SynapseKeyResource and their operations. Each SynapseKeyResource in the collection will belong to the same instance of SynapseWorkspaceResource. To get a SynapseKeyCollection instance call the GetSynapseKeys method from an instance of SynapseWorkspaceResource.

public class SynapseKeyCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Synapse.SynapseKeyResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Synapse.SynapseKeyResource>

type SynapseKeyCollection = class
    inherit ArmCollection
    interface seq<SynapseKeyResource>
    interface IEnumerable
    interface IAsyncEnumerable<SynapseKeyResource>

Public Class SynapseKeyCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of SynapseKeyResource), IEnumerable(Of SynapseKeyResource)

Inheritance: Object

ArmCollection
SynapseKeyCollection

Implements: IAsyncEnumerable<SynapseKeyResource> IEnumerable<SynapseKeyResource> IEnumerable

Constructors

SynapseKeyCollection()

Initializes a new instance of the SynapseKeyCollection class for mocking.

Properties

Client	Gets the ArmClient this resource client was created from. (Inherited from ArmCollection)
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmCollection)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmCollection)
Id	Gets the resource identifier. (Inherited from ArmCollection)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, SynapseKeyData, CancellationToken)	Creates or updates a workspace key Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Operation Id: Keys_CreateOrUpdate
CreateOrUpdateAsync(WaitUntil, String, SynapseKeyData, CancellationToken)	Creates or updates a workspace key Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Operation Id: Keys_CreateOrUpdate
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Operation Id: Keys_Get
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Operation Id: Keys_Get
Get(String, CancellationToken)	Gets a workspace key Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Operation Id: Keys_Get
GetAll(CancellationToken)	Returns a list of keys in a workspace Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys Operation Id: Keys_ListByWorkspace
GetAllAsync(CancellationToken)	Returns a list of keys in a workspace Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys Operation Id: Keys_ListByWorkspace
GetAsync(String, CancellationToken)	Gets a workspace key Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Operation Id: Keys_Get
GetIfExists(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Operation Id: Keys_Get
GetIfExistsAsync(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Operation Id: Keys_Get
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<SynapseKeyResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<SynapseKeyResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.

Applies to

Share via