@azure/arm-kubernetesconfiguration-privatelinkscopes package

Interfaces

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

KubernetesConfigurationPrivateLinkScope

An Azure Arc PrivateLinkScope definition.

KubernetesConfigurationPrivateLinkScopeProperties

Properties that define a Azure Arc PrivateLinkScope resource.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PrivateEndpoint

The private endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionListResult

The response of a PrivateEndpointConnection list operation.

PrivateEndpointConnectionProperties

Properties of the private endpoint connection.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByPrivateLinkScopeOptionalParams

Optional parameters.

PrivateEndpointConnectionsOperations

Interface representing a PrivateEndpointConnections operations.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

The response of a PrivateLinkResource list operation.

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListByPrivateLinkScopeOptionalParams

Optional parameters.

PrivateLinkResourcesOperations

Interface representing a PrivateLinkResources operations.

PrivateLinkScopesClientOptionalParams

Optional parameters for the client.

PrivateLinkScopesCreateOrUpdateOptionalParams

Optional parameters.

PrivateLinkScopesDeleteOptionalParams

Optional parameters.

PrivateLinkScopesGetOptionalParams

Optional parameters.

PrivateLinkScopesListByResourceGroupOptionalParams

Optional parameters.

PrivateLinkScopesListOptionalParams

Optional parameters.

PrivateLinkScopesOperations

Interface representing a PrivateLinkScopes operations.

PrivateLinkScopesUpdateTagsOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
SimplePollerLike

A simple poller that can be used to poll a long running operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

TagsResource

A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

PrivateEndpointConnectionProvisioningState

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Connection has been provisioned
Creating: Connection is being created
Deleting: Connection is being deleted
Failed: Connection provisioning has failed

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Connection waiting for approval or rejection
Approved: Connection approved
Rejected: Connection Rejected

ProvisioningState

The provisioning state of the resource.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Failed: Failed
Canceled: Canceled
Creating: Creating
Updating: Updating
Deleting: Deleting

PublicNetworkAccessType

The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).
KnownPublicNetworkAccessType can be used interchangeably with PublicNetworkAccessType, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints.
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownCreatedByType

The kind of entity that created the resource.

KnownPrivateEndpointConnectionProvisioningState

The current provisioning state.

KnownPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

KnownProvisioningState

The provisioning state of the resource.

KnownPublicNetworkAccessType

The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(PrivateLinkScopesClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(PrivateLinkScopesClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: PrivateLinkScopesClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>