@azure/arm-planetarycomputer package
Classes
SpatioClient |
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. |
GeoCatalog |
A Microsoft Planetary Computer Pro GeoCatalog resource |
GeoCatalogProperties |
The details of the Microsoft Planetary Computer Pro GeoCatalog. |
GeoCatalogUpdate |
The properties of a GeoCatalog that can be updated. |
GeoCatalogsCreateOptionalParams |
Optional parameters. |
GeoCatalogsDeleteOptionalParams |
Optional parameters. |
GeoCatalogsGetOptionalParams |
Optional parameters. |
GeoCatalogsListByResourceGroupOptionalParams |
Optional parameters. |
GeoCatalogsListBySubscriptionOptionalParams |
Optional parameters. |
GeoCatalogsOperations |
Interface representing a GeoCatalogs operations. |
GeoCatalogsUpdateOptionalParams |
Optional parameters. |
ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
ManagedServiceIdentityUpdate |
The template for adding optional properties. |
PageSettings |
Options for the byPage method |
PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
RestorePollerOptions | |
SpatioClientOptionalParams |
Optional parameters for the client. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
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 |
Type Aliases
AutoGeneratedDomainNameLabelScope |
The scope at which the auto-generated domain name label is generated and at which the resource name can be reused. Known values supported by the serviceNoReuse: The domain name label is randomly generated. The resource name cannot be reused within the same region. |
CatalogTier |
The Microsoft Planetary Computer Pro GeoCatalog tier Known values supported by the serviceBasic: The basic tier that utilizes shared resources across catalog instances |
ContinuablePage |
An interface that describes a page of results. |
CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
ProvisioningState |
The status of the current operation. Known values supported by the serviceSucceeded: Resource has been created. |
Enums
KnownAutoGeneratedDomainNameLabelScope |
The scope at which the auto-generated domain name label is generated and at which the resource name can be reused. |
KnownCatalogTier |
The Microsoft Planetary Computer Pro GeoCatalog tier |
KnownCreatedByType |
The kind of entity that created the resource. |
KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
KnownProvisioningState |
The status of the current operation. |
KnownVersions |
Known values of KnownVersions that the service accepts. |
Functions
restore |
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>(SpatioClient, 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: SpatioClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- SpatioClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>