@azure/arm-napsteromniagentapi package

類別

介面

ActivateSaaSParameterRequest	SaaS guid & PublishedId 用於啟用和驗證 SaaS 資源
CompanionAPIClientOptionalParams	用戶端的選擇性參數。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。
LatestLinkedSaaSResponse	獲取最新連結的 SaaS 資源作的回應
ManagedServiceIdentity	受控服務識別（系統指派和/或使用者指派的身分識別）
MarketplaceDetails	組織的市場資訊
OfferDetails	用戶選取之市集的供應專案詳細數據
Operation	從資源提供者作業 API API 傳回的 REST API 作業詳細數據
OperationDisplay	操作的在地顯示資訊。
OperationsListOptionalParams	選擇性參數。
OperationsOperations	代表作業作業的介面。
OrganizationProperties	組織特有的屬性
OrganizationResource	您可以使用特定屬性類型來建立具象追蹤的資源類型。
OrganizationResourceUpdate	用於組織資源更新操作的類型。
OrganizationsCreateOrUpdateOptionalParams	選擇性參數。
OrganizationsDeleteOptionalParams	選擇性參數。
OrganizationsGetOptionalParams	選擇性參數。
OrganizationsLatestLinkedSaaSOptionalParams	選擇性參數。
OrganizationsLinkSaaSOptionalParams	選擇性參數。
OrganizationsListByResourceGroupOptionalParams	選擇性參數。
OrganizationsListBySubscriptionOptionalParams	選擇性參數。
OrganizationsOperations	介面代表組織營運。
OrganizationsUpdateOptionalParams	選擇性參數。
PageSettings	byPage 方法的選項
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
PartnerProperties	合夥人特定屬性
ProxyResource	Azure Resource Manager Proxy 資源的資源模型定義。它不會有標記和位置
Resource	回應中針對所有 Azure Resource Manager 資源傳回的常見欄位
RestorePollerOptions
SaaSData	SaaS 相關資料屬性
SaaSOperationGroupActivateResourceOptionalParams	選擇性參數。
SaaSOperationGroupOperations	介面代表 SaaSOperationGroup 的運作。
SaaSResourceDetailsResponse	Marketplace SaaS 資源詳細資訊。
SingleSignOnPropertiesV2	單一登入資源專屬的屬性
SystemData	與建立和上次修改資源相關的元數據。
TrackedResource	Azure Resource Manager 的資源模型定義已追蹤最上層資源，其具有「標記」和「位置」
UserAssignedIdentity	使用者指派的身分識別屬性
UserDetails	組織的使用者資料

類型別名

ActionType	可延伸列舉。表示動作類型。「內部」是指僅供內部 API 使用的動作。 KnownActionType 可以與 ActionType 交替使用，此列舉包含服務支援的已知值。服務支援的已知值內部：動作適用於僅限內部的 API。
AzureSupportedClouds	雲端設定為字串常值類型的支援值
ContinuablePage	描述結果頁面的介面。
CreatedByType	建立資源的實體種類。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。服務支援的已知值使用者：實體是由使用者建立的。應用程式：實體是由應用程式所建立。 ManagedIdentity：實體是由受控識別所建立。金鑰：實體是由金鑰所建立。
ManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。 KnownManagedServiceIdentityType 可以與 ManagedServiceIdentityType 交換使用，此列舉包含服務支援的已知值。服務支援的已知值無：沒有受控識別。 SystemAssigned：系統指派的受控識別。 UserAssigned：使用者指派的受控識別。 SystemAssigned，UserAssigned：系統和使用者指派的受控識別。
MarketplaceSubscriptionStatus	資源的市集訂閱狀態。 KnownMarketplaceSubscriptionStatus 可以與 MarketplaceSubscriptionStatus 交替使用，此列舉包含服務支援的已知值。服務支援的已知值 PendingFulfillmentStart：已購買但尚未啟用訂閱：市集訂閱已啟動暫停狀態：此狀態表示客戶未收到市場服務的付款取消訂閱：客戶已取消訂閱
Origin	作業的預期執行程式;如同資源型存取控制（RBAC）和稽核記錄 UX。默認值為 “user，system” KnownOrigin 可以與 Origin 互換使用，此列舉包含服務支援的已知值。服務支援的已知值 user：表示作業是由使用者起始。 system：指出作業是由系統起始。 user，system：指出作業是由使用者或系統起始。
ResourceProvisioningState	資源類型的佈建狀態。 KnownResourceProvisioningState 可以與 ResourceProvisioningState 互換使用，此列舉包含服務支援的已知值。服務支援的已知值成功：資源已建立。失敗：資源建立失敗。已取消：已取消資源建立。
SingleSignOnStates	SSO 資源的各種狀態 KnownSingleSignOnStates 可與 SingleSignOnStates 互換使用，此枚舉包含服務所支援的已知值。服務支援的已知值初始值：SSO 資源的初始狀態啟用：啟用 SSO 資源時的狀態停用：當 SSO 資源被停用時的狀態
SingleSignOnType	定義所使用的單一 Sign-On（SSO）機制類型 KnownSingleSignOnType 可與 SingleSignOnType 互換使用，此枚舉包含服務所支援的已知值。服務支援的已知值 Saml：基於安全主張標記語言（SAML）的單一 Sign-On OpenId：基於 OpenID Connect 的單一登入。

列舉

AzureClouds	一個用來描述 Azure Cloud 環境的 enum。
KnownActionType	可延伸列舉。表示動作類型。「內部」是指僅供內部 API 使用的動作。
KnownCreatedByType	建立資源的實體種類。
KnownManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。
KnownMarketplaceSubscriptionStatus	資源的市集訂閱狀態。
KnownOrigin	作業的預期執行程式;如同資源型存取控制（RBAC）和稽核記錄 UX。默認值為 “user，system”
KnownResourceProvisioningState	資源類型的佈建狀態。
KnownSingleSignOnStates	SSO 資源的各種狀態
KnownSingleSignOnType	定義所使用的單一 Sign-On（SSO）機制類型
KnownVersions	可用的 API 版本。

函式

isRestError(unknown)	RestError 的 Typeguard
restorePoller<TResponse, TResult>(CompanionAPIClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	從另一個輪詢器的序列化狀態建立輪詢器。當您想要在不同的主機上建立輪詢器，或需要在原始輪詢器不在範圍內之後建構輪詢器時，這會很有用。

變數

RestError

失敗管線要求的自定義錯誤類型。

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

參數

e: unknown

catch 子句攔截到的東西。

傳回

e

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

從另一個輪詢器的序列化狀態建立輪詢器。當您想要在不同的主機上建立輪詢器，或需要在原始輪詢器不在範圍內之後建構輪詢器時，這會很有用。

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

參數

client: CompanionAPIClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

傳回

PollerLike<OperationState<TResult>, TResult>

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型

RestErrorConstructor

@azure/arm-napsteromniagentapi package

類別

介面

類型別名

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

列舉

函式

變數

函式詳細資料

isRestError(unknown)

參數

傳回

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

參數

傳回

變數詳細資料

RestError

類型

意見反應