@azure/arm-discovery package

Classes

DiscoveryClient

Interfaces

AzureNetAppFilesStore

The Azure NetApp Files properties.

AzureStorageBlobStore

The Azure storage blob properties.

Bookshelf

Bookshelf tracked resource

BookshelfKeyVaultProperties

Key Vault Properties with clientId selection

BookshelfKeyVaultUpdateProperties

Key Vault update properties for Bookshelf (all fields optional for PATCH)

BookshelfPrivateEndpointConnection

The Private Endpoint Connection resource for Bookshelf.

BookshelfPrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

BookshelfPrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

BookshelfPrivateEndpointConnectionsGetOptionalParams

Optional parameters.

BookshelfPrivateEndpointConnectionsListByBookshelfOptionalParams

Optional parameters.

BookshelfPrivateEndpointConnectionsOperations

Interface representing a BookshelfPrivateEndpointConnections operations.

BookshelfPrivateLinkResource

A private link resource for Bookshelf.

BookshelfPrivateLinkResourcesGetOptionalParams

Optional parameters.

BookshelfPrivateLinkResourcesListByBookshelfOptionalParams

Optional parameters.

BookshelfPrivateLinkResourcesOperations

Interface representing a BookshelfPrivateLinkResources operations.

BookshelfProperties

Bookshelf properties

BookshelfUpdate

The type used for update operations of the Bookshelf.

BookshelfUpdateProperties

The updatable properties of the Bookshelf.

BookshelvesCreateOrUpdateOptionalParams

Optional parameters.

BookshelvesDeleteOptionalParams

Optional parameters.

BookshelvesGetOptionalParams

Optional parameters.

BookshelvesListByResourceGroupOptionalParams

Optional parameters.

BookshelvesListBySubscriptionOptionalParams

Optional parameters.

BookshelvesOperations

Interface representing a Bookshelves operations.

BookshelvesUpdateOptionalParams

Optional parameters.

ChatModelDeployment

Represents a deployment that ties a specific model family to a user defined deployment name used when invoking the chat model.

ChatModelDeploymentProperties

Defines a deployment binding a specific model family to a user-defined deployment name for chat inference.

ChatModelDeploymentUpdate

Represents a deployment that ties a specific model family to a user defined deployment name used when invoking the chat model.

ChatModelDeploymentsCreateOrUpdateOptionalParams

Optional parameters.

ChatModelDeploymentsDeleteOptionalParams

Optional parameters.

ChatModelDeploymentsGetOptionalParams

Optional parameters.

ChatModelDeploymentsListByWorkspaceOptionalParams

Optional parameters.

ChatModelDeploymentsOperations

Interface representing a ChatModelDeployments operations.

ChatModelDeploymentsUpdateOptionalParams

Optional parameters.

DiscoveryClientOptionalParams

Optional parameters for the client.

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.

Identity

For user assigned identity resource property.

KeyVaultProperties

For Key Vault Key references

KeyVaultUpdateProperties

For Key Vault Key references

MoboBrokerResource

Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user.

NodePool

NodePool tracked resource

NodePoolProperties

NodePool properties

NodePoolUpdate

NodePool tracked resource

NodePoolUpdateProperties

NodePool properties

NodePoolsCreateOrUpdateOptionalParams

Optional parameters.

NodePoolsDeleteOptionalParams

Optional parameters.

NodePoolsGetOptionalParams

Optional parameters.

NodePoolsListBySupercomputerOptionalParams

Optional parameters.

NodePoolsOperations

Interface representing a NodePools operations.

NodePoolsUpdateOptionalParams

Optional parameters.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for an operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

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

PrivateEndpointConnectionProperties

Properties of the private endpoint connection.

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkServiceConnectionState

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

Project

Project tracked resource

ProjectProperties

Project properties

ProjectSettings

Settings schema for the project

ProjectUpdate

Project tracked resource

ProjectUpdateProperties

Project properties

ProjectsCreateOrUpdateOptionalParams

Optional parameters.

ProjectsDeleteOptionalParams

Optional parameters.

ProjectsGetOptionalParams

Optional parameters.

ProjectsListByWorkspaceOptionalParams

Optional parameters.

ProjectsOperations

Interface representing a Projects operations.

ProjectsUpdateOptionalParams

Optional parameters.

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
StorageAsset

Storage Asset tracked resource

StorageAssetProperties

Storage Asset properties

StorageAssetUpdate

Storage Asset tracked resource

StorageAssetUpdateProperties

Storage Asset properties

StorageAssetsCreateOrUpdateOptionalParams

Optional parameters.

StorageAssetsDeleteOptionalParams

Optional parameters.

StorageAssetsGetOptionalParams

Optional parameters.

StorageAssetsListByStorageContainerOptionalParams

Optional parameters.

StorageAssetsOperations

Interface representing a StorageAssets operations.

StorageAssetsUpdateOptionalParams

Optional parameters.

StorageContainer

Storage Container tracked resource

StorageContainerProperties

Storage Container properties

StorageContainerUpdate

Storage Container tracked resource

StorageContainersCreateOrUpdateOptionalParams

Optional parameters.

StorageContainersDeleteOptionalParams

Optional parameters.

StorageContainersGetOptionalParams

Optional parameters.

StorageContainersListByResourceGroupOptionalParams

Optional parameters.

StorageContainersListBySubscriptionOptionalParams

Optional parameters.

StorageContainersOperations

Interface representing a StorageContainers operations.

StorageContainersUpdateOptionalParams

Optional parameters.

StorageStore

An abstract representation of storage store kind.

Supercomputer

Supercomputer tracked resource

SupercomputerIdentities

Dictionary of identity properties for the Supercomputer.

SupercomputerIdentitiesUpdate

Dictionary of identity properties for the Supercomputer.

SupercomputerProperties

Supercomputer properties

SupercomputerUpdate

Update model for Supercomputer PATCH operations

SupercomputerUpdateProperties

Updatable properties for Supercomputer (all fields optional for PATCH)

SupercomputersCreateOrUpdateOptionalParams

Optional parameters.

SupercomputersDeleteOptionalParams

Optional parameters.

SupercomputersGetOptionalParams

Optional parameters.

SupercomputersListByResourceGroupOptionalParams

Optional parameters.

SupercomputersListBySubscriptionOptionalParams

Optional parameters.

SupercomputersOperations

Interface representing a Supercomputers operations.

SupercomputersUpdateOptionalParams

Optional parameters.

SystemData

Metadata pertaining to creation and last modification of the resource.

Tool

Tool tracked resource

ToolProperties

Discovery Tool list item properties

ToolUpdate

Tool tracked resource

ToolUpdateProperties

Discovery Tool list item properties

ToolsCreateOrUpdateOptionalParams

Optional parameters.

ToolsDeleteOptionalParams

Optional parameters.

ToolsGetOptionalParams

Optional parameters.

ToolsListByResourceGroupOptionalParams

Optional parameters.

ToolsListBySubscriptionOptionalParams

Optional parameters.

ToolsOperations

Interface representing a Tools operations.

ToolsUpdateOptionalParams

Optional parameters.

TrackedResource

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

UserAssignedIdentity

User assigned identity properties

WithMoboBrokerResources

For tracking mobo resources

Workspace

Workspace tracked resource

WorkspacePrivateEndpointConnection

The Private Endpoint Connection resource for Workspace.

WorkspacePrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

WorkspacePrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

WorkspacePrivateEndpointConnectionsGetOptionalParams

Optional parameters.

WorkspacePrivateEndpointConnectionsListByWorkspaceOptionalParams

Optional parameters.

WorkspacePrivateEndpointConnectionsOperations

Interface representing a WorkspacePrivateEndpointConnections operations.

WorkspacePrivateLinkResource

A private link resource for Workspace.

WorkspacePrivateLinkResourcesGetOptionalParams

Optional parameters.

WorkspacePrivateLinkResourcesListByWorkspaceOptionalParams

Optional parameters.

WorkspacePrivateLinkResourcesOperations

Interface representing a WorkspacePrivateLinkResources operations.

WorkspaceProperties

Workspace properties

WorkspaceUpdate

Update model for Workspace PATCH operations

WorkspaceUpdateProperties

Updatable properties for Workspace (all fields optional for PATCH)

WorkspacesCreateOrUpdateOptionalParams

Optional parameters.

WorkspacesDeleteOptionalParams

Optional parameters.

WorkspacesGetOptionalParams

Optional parameters.

WorkspacesListByResourceGroupOptionalParams

Optional parameters.

WorkspacesListBySubscriptionOptionalParams

Optional parameters.

WorkspacesOperations

Interface representing a Workspaces operations.

WorkspacesUpdateOptionalParams

Optional parameters.

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

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.

CustomerManagedKeys

State of customer managed key usage.
KnownCustomerManagedKeys can be used interchangeably with CustomerManagedKeys, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Customer managed keys are enabled.
Disabled: Customer managed keys are disabled.

NetworkEgressType

Supported network egress types.
KnownNetworkEgressType can be used interchangeably with NetworkEgressType, this enum contains the known values that the service supports.

Known values supported by the service

LoadBalancer: Public outbound network via load balancer (Default)
None: No default outbound

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

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 resource provisioning state.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Accepted: The resource create request has been accepted
Provisioning: The resource is being provisioned
Updating: The resource is updating
Deleting: The resource is being deleted

PublicNetworkAccess

State of public network access.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Public network access is enabled.
Disabled: Public network access is disabled.

ScaleSetPriority

Supported Virtual Machine Scale Set priorities.
KnownScaleSetPriority can be used interchangeably with ScaleSetPriority, this enum contains the known values that the service supports.

Known values supported by the service

Regular: Regular priority Virtual Machine Scale Set.
Spot: Spot priority Virtual Machine Scale Set.

StorageStoreType

The kind of the backing storage store.
KnownStorageStoreType can be used interchangeably with StorageStoreType, this enum contains the known values that the service supports.

Known values supported by the service

AzureStorageBlob: The Azure storage blob kind.
AzureNetAppFiles: The Azure NetApp Files kind.

StorageStoreUnion

Alias for StorageStoreUnion

SystemSku

Supported System SKU Sizes.
KnownSystemSku can be used interchangeably with SystemSku, this enum contains the known values that the service supports.

Known values supported by the service

Standard_D4s_v6: Standard_D4s_v6 basic compute VM (default)
Standard_D4s_v5: Standard_D4s_v5 SKU
Standard_D4s_v4: Standard_D4s_v4 SKU

VmSize

Supported Azure VM Sizes.
KnownVmSize can be used interchangeably with VmSize, this enum contains the known values that the service supports.

Known values supported by the service

Standard_NC24ads_A100_v4: Standard_NC24ads_A100_v4 GPU-optimized Azure VM Size
Standard_NC48ads_A100_v4: Standard_NC48ads_A100_v4 GPU-optimized Azure VM Size
Standard_NC96ads_A100_v4: Standard_NC96ads_A100_v4 GPU-optimized Azure VM Size
Standard_NC4as_T4_v3: Standard_NC4as_T4_v3 GPU-optimized Azure VM Size
Standard_NC8as_T4_v3: Standard_NC8as_T4_v3 GPU-optimized Azure VM Size
Standard_NC16as_T4_v3: Standard_NC16as_T4_v3 GPU-optimized Azure VM Size
Standard_NC64as_T4_v3: Standard_NC64as_T4_v3 GPU-optimized Azure VM Size
Standard_NV6ads_A10_v5: Standard_NV6ads_A10_v5 GPU-optimized Azure VM Size
Standard_NV12ads_A10_v5: Standard_NV12ads_A10_v5 GPU-optimized Azure VM Size
Standard_NV24ads_A10_v5: Standard_NV24ads_A10_v5 GPU-optimized Azure VM Size
Standard_NV36ads_A10_v5: Standard_NV36ads_A10_v5 GPU-optimized Azure VM Size
Standard_NV36adms_A10_v5: Standard_NV36ads_A10_v5 GPU-optimized Azure VM Size
Standard_NV72ads_A10_v5: Standard_NV36ads_A10_v5 GPU-optimized Azure VM Size
Standard_ND40rs_v2: Standard_ND40rs_v2 GPU-optimized Azure VM Size

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownCreatedByType

The kind of entity that created the resource.

KnownCustomerManagedKeys

State of customer managed key usage.

KnownNetworkEgressType

Supported network egress types.

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownPrivateEndpointConnectionProvisioningState

The current provisioning state.

KnownPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

KnownProvisioningState

The resource provisioning state.

KnownPublicNetworkAccess

State of public network access.

KnownScaleSetPriority

Supported Virtual Machine Scale Set priorities.

KnownStorageStoreType

The kind of the backing storage store.

KnownSystemSku

Supported System SKU Sizes.

KnownVersions

The available API versions.

KnownVmSize

Supported Azure VM Sizes.

Functions

restorePoller<TResponse, TResult>(DiscoveryClient, 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>(DiscoveryClient, 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: DiscoveryClient, 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>