次の方法で共有


@azure/arm-apicenter package

クラス

AzureAPICenter

インターフェイス

Api

API エンティティ。

ApiDefinition

API 定義エンティティ。

ApiDefinitionListResult

ApiDefinition リスト操作の応答。

ApiDefinitionProperties

API 定義プロパティ エンティティ。

ApiDefinitionPropertiesSpecification

API 仕様の詳細。

ApiDefinitions

ApiDefinitions を表すインターフェイス。

ApiDefinitionsCreateOrUpdateHeaders

ApiDefinitions_createOrUpdate操作のヘッダーを定義します。

ApiDefinitionsCreateOrUpdateOptionalParams

省略可能なパラメーター。

ApiDefinitionsDeleteOptionalParams

省略可能なパラメーター。

ApiDefinitionsExportSpecificationHeaders

ApiDefinitions_exportSpecification操作のヘッダーを定義します。

ApiDefinitionsExportSpecificationOptionalParams

省略可能なパラメーター。

ApiDefinitionsGetHeaders

ApiDefinitions_get操作のヘッダーを定義します。

ApiDefinitionsGetOptionalParams

省略可能なパラメーター。

ApiDefinitionsHeadOptionalParams

省略可能なパラメーター。

ApiDefinitionsImportSpecificationHeaders

ApiDefinitions_importSpecification操作のヘッダーを定義します。

ApiDefinitionsImportSpecificationOptionalParams

省略可能なパラメーター。

ApiDefinitionsListNextOptionalParams

省略可能なパラメーター。

ApiDefinitionsListOptionalParams

省略可能なパラメーター。

ApiListResult

Api リスト操作の応答。

ApiProperties

API プロパティ。

ApiSpecExportResult

API 仕様のエクスポート結果。

ApiSpecImportRequest

API 仕様のソース エンティティ プロパティ。

ApiSpecImportRequestSpecification

API 仕様の詳細。

ApiVersion

API バージョン エンティティ。

ApiVersionListResult

ApiVersion リスト操作の応答。

ApiVersionProperties

API バージョンのプロパティ エンティティ。

ApiVersions

ApiVersions を表すインターフェイス。

ApiVersionsCreateOrUpdateHeaders

ApiVersions_createOrUpdate操作のヘッダーを定義します。

ApiVersionsCreateOrUpdateOptionalParams

省略可能なパラメーター。

ApiVersionsDeleteOptionalParams

省略可能なパラメーター。

ApiVersionsGetHeaders

ApiVersions_get操作のヘッダーを定義します。

ApiVersionsGetOptionalParams

省略可能なパラメーター。

ApiVersionsHeadOptionalParams

省略可能なパラメーター。

ApiVersionsListNextOptionalParams

省略可能なパラメーター。

ApiVersionsListOptionalParams

省略可能なパラメーター。

Apis

Api を表すインターフェイス。

ApisCreateOrUpdateHeaders

Apis_createOrUpdate操作のヘッダーを定義します。

ApisCreateOrUpdateOptionalParams

省略可能なパラメーター。

ApisDeleteOptionalParams

省略可能なパラメーター。

ApisGetHeaders

Apis_get操作のヘッダーを定義します。

ApisGetOptionalParams

省略可能なパラメーター。

ApisHeadOptionalParams

省略可能なパラメーター。

ApisListNextOptionalParams

省略可能なパラメーター。

ApisListOptionalParams

省略可能なパラメーター。

AzureAPICenterOptionalParams

省略可能なパラメーター。

Contact

連絡先情報

Deployment

API デプロイ エンティティ。

DeploymentListResult

デプロイ リスト操作の応答。

DeploymentProperties

API デプロイ エンティティのプロパティ。

DeploymentServer

サーバー

Deployments

デプロイを表すインターフェイス。

DeploymentsCreateOrUpdateHeaders

Deployments_createOrUpdate操作のヘッダーを定義します。

DeploymentsCreateOrUpdateOptionalParams

省略可能なパラメーター。

DeploymentsDeleteOptionalParams

省略可能なパラメーター。

DeploymentsGetHeaders

Deployments_get操作のヘッダーを定義します。

DeploymentsGetOptionalParams

省略可能なパラメーター。

DeploymentsHeadOptionalParams

省略可能なパラメーター。

DeploymentsListNextOptionalParams

省略可能なパラメーター。

DeploymentsListOptionalParams

省略可能なパラメーター。

Environment

環境エンティティ。

EnvironmentListResult

環境リスト操作の応答。

EnvironmentProperties

環境プロパティ エンティティ。

EnvironmentServer

環境のサーバー情報。

Environments

環境を表すインターフェイス。

EnvironmentsCreateOrUpdateHeaders

Environments_createOrUpdate操作のヘッダーを定義します。

EnvironmentsCreateOrUpdateOptionalParams

省略可能なパラメーター。

EnvironmentsDeleteOptionalParams

省略可能なパラメーター。

EnvironmentsGetHeaders

Environments_get操作のヘッダーを定義します。

EnvironmentsGetOptionalParams

省略可能なパラメーター。

EnvironmentsHeadOptionalParams

省略可能なパラメーター。

EnvironmentsListNextOptionalParams

省略可能なパラメーター。

EnvironmentsListOptionalParams

省略可能なパラメーター。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは OData エラー応答形式にも従います)。

ExternalDocumentation

API のその他の外部ドキュメント。

License

API のライセンス情報。

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

MetadataAssignment

割り当てメタデータ

MetadataSchema

メタデータ スキーマ エンティティ。 API カタログ内のエンティティのメタデータを定義するために使用されます。

MetadataSchemaExportRequest

メタデータ スキーマのエクスポート要求。

MetadataSchemaExportResult

メタデータ スキーマのエクスポート結果。

MetadataSchemaListResult

MetadataSchema リスト操作の応答。

MetadataSchemaProperties

メタデータ スキーマのプロパティ。

MetadataSchemas

MetadataSchemas を表すインターフェイス。

MetadataSchemasCreateOrUpdateHeaders

MetadataSchemas_createOrUpdate操作のヘッダーを定義します。

MetadataSchemasCreateOrUpdateOptionalParams

省略可能なパラメーター。

MetadataSchemasDeleteOptionalParams

省略可能なパラメーター。

MetadataSchemasGetHeaders

MetadataSchemas_get操作のヘッダーを定義します。

MetadataSchemasGetOptionalParams

省略可能なパラメーター。

MetadataSchemasHeadOptionalParams

省略可能なパラメーター。

MetadataSchemasListNextOptionalParams

省略可能なパラメーター。

MetadataSchemasListOptionalParams

省略可能なパラメーター。

Onboarding

オンボード情報

Operation

リソース プロバイダー操作 API から返される REST API 操作の詳細

OperationDisplay

この特定の操作のローカライズされた表示情報。

OperationListResult

Azure リソース プロバイダーでサポートされている REST API 操作の一覧。 次の結果セットを取得するための URL リンクが含まれています。

Operations

操作を表すインターフェイス。

OperationsListNextOptionalParams

省略可能なパラメーター。

OperationsListOptionalParams

省略可能なパラメーター。

ProxyResource

Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません

Resource

すべての Azure Resource Manager リソースの応答で返される共通フィールド

Service

サービス エンティティ。

ServiceListResult

サービス リスト操作の応答。

ServiceProperties

サービスのプロパティ。

ServiceUpdate

サービスの更新操作に使用される型。

Services

サービスを表すインターフェイス。

ServicesCreateOrUpdateOptionalParams

省略可能なパラメーター。

ServicesDeleteOptionalParams

省略可能なパラメーター。

ServicesExportMetadataSchemaHeaders

Services_exportMetadataSchema操作のヘッダーを定義します。

ServicesExportMetadataSchemaOptionalParams

省略可能なパラメーター。

ServicesGetOptionalParams

省略可能なパラメーター。

ServicesListByResourceGroupNextOptionalParams

省略可能なパラメーター。

ServicesListByResourceGroupOptionalParams

省略可能なパラメーター。

ServicesListBySubscriptionNextOptionalParams

省略可能なパラメーター。

ServicesListBySubscriptionOptionalParams

省略可能なパラメーター。

ServicesUpdateOptionalParams

省略可能なパラメーター。

SystemData

リソースの作成と最後の変更に関連するメタデータ。

TermsOfService

API のサービス条件。

TrackedResource

'tags' と 'location' を持つ、Azure Resource Manager追跡される最上位リソースのリソース モデル定義

UserAssignedIdentity

ユーザー割り当て ID プロパティ

Workspace

ワークスペース エンティティ。

WorkspaceListResult

ワークスペース リスト操作の応答。

WorkspaceProperties

ワークスペースのプロパティ。

Workspaces

ワークスペースを表すインターフェイス。

WorkspacesCreateOrUpdateHeaders

Workspaces_createOrUpdate操作のヘッダーを定義します。

WorkspacesCreateOrUpdateOptionalParams

省略可能なパラメーター。

WorkspacesDeleteOptionalParams

省略可能なパラメーター。

WorkspacesGetHeaders

Workspaces_get操作のヘッダーを定義します。

WorkspacesGetOptionalParams

省略可能なパラメーター。

WorkspacesHeadOptionalParams

省略可能なパラメーター。

WorkspacesListNextOptionalParams

省略可能なパラメーター。

WorkspacesListOptionalParams

省略可能なパラメーター。

型エイリアス

ActionType

ActionType の値を定義します。
KnownActionType は ActionType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

内部

ApiDefinitionsCreateOrUpdateResponse

createOrUpdate 操作の応答データを格納します。

ApiDefinitionsExportSpecificationResponse

exportSpecification 操作の応答データを格納します。

ApiDefinitionsGetResponse

get 操作の応答データが含まれます。

ApiDefinitionsHeadResponse

ヘッド操作の応答データを格納します。

ApiDefinitionsListNextResponse

listNext 操作の応答データを格納します。

ApiDefinitionsListResponse

リスト操作の応答データが含まれます。

ApiKind

ApiKind の値を定義します。
KnownApiKind は ApiKind と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

サービスでサポートされている既知の値

rest: Representational State Transfer Api
graphql: Graph クエリ言語 Api
grpc: gRPC Api
soap: SOAP Api
webhook: Web Hook
websocket: Web ソケット

ApiSpecExportResultFormat

ApiSpecExportResultFormat の値を定義します。
KnownApiSpecExportResultFormat は ApiSpecExportResultFormat と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

inline: 仕様ドキュメントのインラインコンテンツ。
link: エクスポート操作の結果へのリンク。 URL は 5 分間有効です。

ApiSpecImportSourceFormat

ApiSpecImportSourceFormat の値を定義します。
KnownApiSpecImportSourceFormat は ApiSpecImportSourceFormat と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

inline: 仕様ドキュメントのインラインコンテンツ。
link: パブリックにアクセス可能なインターネット アドレスでホストされている仕様ドキュメントへのリンク。

ApiVersionsCreateOrUpdateResponse

createOrUpdate 操作の応答データを格納します。

ApiVersionsGetResponse

get 操作の応答データが含まれます。

ApiVersionsHeadResponse

ヘッド操作の応答データを格納します。

ApiVersionsListNextResponse

listNext 操作の応答データを格納します。

ApiVersionsListResponse

リスト操作の応答データが含まれます。

ApisCreateOrUpdateResponse

createOrUpdate 操作の応答データを格納します。

ApisGetResponse

get 操作の応答データが含まれます。

ApisHeadResponse

ヘッド操作の応答データを格納します。

ApisListNextResponse

listNext 操作の応答データを格納します。

ApisListResponse

リスト操作の応答データが含まれます。

CreatedByType

CreatedByType の値を定義します。
KnownCreatedByType は CreatedByType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

User
Application
ManagedIdentity
キー

DeploymentState

DeploymentState の値を定義します。
KnownDeploymentState は DeploymentState と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

active: アクティブな状態
非アクティブ: 非アクティブ状態

DeploymentsCreateOrUpdateResponse

createOrUpdate 操作の応答データを格納します。

DeploymentsGetResponse

get 操作の応答データが含まれます。

DeploymentsHeadResponse

ヘッド操作の応答データを格納します。

DeploymentsListNextResponse

listNext 操作の応答データを格納します。

DeploymentsListResponse

リスト操作の応答データが含まれます。

EnvironmentKind

EnvironmentKind の値を定義します。
KnownEnvironmentKind は EnvironmentKind と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

開発: 開発環境
テスト: テスト環境
ステージング: ステージング環境
運用環境: 運用環境

EnvironmentServerType

EnvironmentServerType の値を定義します。
KnownEnvironmentServerType は EnvironmentServerType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

Azure API Management: Api Management Server
Azure コンピューティング サービス: コンピューティング サーバー
Apigee API Management: Apigee サーバー
AWS API Gateway: AWS Api Gateway サーバー
Kong API Gateway: Kong API Gateway サーバー
Kubernetes: Kubernetes サーバー
MuleSoft API Management: Mulesoft Api Management サーバー

EnvironmentsCreateOrUpdateResponse

createOrUpdate 操作の応答データを格納します。

EnvironmentsGetResponse

get 操作の応答データが含まれます。

EnvironmentsHeadResponse

ヘッド操作の応答データを格納します。

EnvironmentsListNextResponse

listNext 操作の応答データを格納します。

EnvironmentsListResponse

リスト操作の応答データが含まれます。

LifecycleStage

LifecycleStage の値を定義します。
KnownLifecycleStage は LifecycleStage と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

デザイン: デザイン ステージ
開発: 開発ステージ
テスト: テスト ステージ
プレビュー: プレビュー中
production: 運用環境
非推奨: 非推奨のステージ
廃止済み: 廃止されたステージ

ManagedServiceIdentityType

ManagedServiceIdentityType の値を定義します。
KnownManagedServiceIdentityType は ManagedServiceIdentityType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

なし
SystemAssigned
UserAssigned
SystemAssigned、UserAssigned

MetadataAssignmentEntity

MetadataAssignmentEntity の値を定義します。
KnownMetadataAssignmentEntity は MetadataAssignmentEntity と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

api: API に割り当てられます
environment: 環境に割り当て済み
deployment: Deployment に割り当て済み

MetadataSchemaExportFormat

MetadataSchemaExportFormat の値を定義します。
KnownMetadataSchemaExportFormat は MetadataSchemaExportFormat と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

サービスでサポートされている既知の値

inline: スキーマ ドキュメントのインラインコンテンツ。
link: スキーマ ドキュメントへのリンク。 URL は 5 分間有効です。

MetadataSchemasCreateOrUpdateResponse

createOrUpdate 操作の応答データが含まれます。

MetadataSchemasGetResponse

get 操作の応答データが含まれます。

MetadataSchemasHeadResponse

ヘッド操作の応答データが含まれます。

MetadataSchemasListNextResponse

listNext 操作の応答データが含まれます。

MetadataSchemasListResponse

リスト操作の応答データが含まれます。

OperationsListNextResponse

listNext 操作の応答データが含まれます。

OperationsListResponse

リスト操作の応答データが含まれます。

Origin

Origin の値を定義します。
KnownOrigin は Origin と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

user
システム
user,system

ProvisioningState

ProvisioningState の値を定義します。
KnownProvisioningState は ProvisioningState と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

成功: リソースが作成されました。
失敗: リソースの作成に失敗しました。
キャンセル済み: リソースの作成が取り消されました。

ServicesCreateOrUpdateResponse

createOrUpdate 操作の応答データが含まれます。

ServicesExportMetadataSchemaResponse

exportMetadataSchema 操作の応答データが含まれます。

ServicesGetResponse

get 操作の応答データが含まれます。

ServicesListByResourceGroupNextResponse

listByResourceGroupNext 操作の応答データが含まれます。

ServicesListByResourceGroupResponse

listByResourceGroup 操作の応答データが含まれます。

ServicesListBySubscriptionNextResponse

listBySubscriptionNext 操作の応答データを格納します。

ServicesListBySubscriptionResponse

listBySubscription 操作の応答データが含まれます。

ServicesUpdateResponse

更新操作の応答データが含まれます。

Versions

バージョンの値を定義します。
KnownVersions は Versions と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

2024-03-01: 初期サービス バージョン

WorkspacesCreateOrUpdateResponse

createOrUpdate 操作の応答データが含まれます。

WorkspacesGetResponse

get 操作の応答データが含まれます。

WorkspacesHeadResponse

ヘッド操作の応答データが含まれます。

WorkspacesListNextResponse

listNext 操作の応答データが含まれます。

WorkspacesListResponse

リスト操作の応答データが含まれます。

列挙型

KnownActionType

サービスが受け入れる ActionType の既知の値。

KnownApiKind

サービスが受け入れる ApiKind の既知の値。

KnownApiSpecExportResultFormat

サービスが受け入れる ApiSpecExportResultFormat の既知の値。

KnownApiSpecImportSourceFormat

サービスが受け入れる ApiSpecImportSourceFormat の既知の値。

KnownCreatedByType

サービスが受け入れる CreatedByType の既知の値。

KnownDeploymentState

サービスが受け入れる DeploymentState の既知の値。

KnownEnvironmentKind

サービスが受け入れる EnvironmentKind の既知の値。

KnownEnvironmentServerType

サービスが受け入れる EnvironmentServerType の既知の値。

KnownLifecycleStage

サービスが受け入れる LifecycleStage の既知の値。

KnownManagedServiceIdentityType

サービスが受け入れる ManagedServiceIdentityType の既知の値。

KnownMetadataAssignmentEntity

サービスが受け入れる MetadataAssignmentEntity の既知の値。

KnownMetadataSchemaExportFormat

サービスが受け入れる MetadataSchemaExportFormat の既知の値。

KnownOrigin

サービスが受け入れる Origin の既知の値。

KnownProvisioningState

サービスが受け入れる ProvisioningState の既知の値。

KnownVersions

サービスが受け入れる バージョン の既知の値。

機能

getContinuationToken(unknown)

反復子によってbyPage最後.valueに生成された を指定すると、後でそのポイントからページングを開始するために使用できる継続トークンが返されます。

関数の詳細

getContinuationToken(unknown)

反復子によってbyPage最後.valueに生成された を指定すると、後でそのポイントからページングを開始するために使用できる継続トークンが返されます。

function getContinuationToken(page: unknown): string | undefined

パラメーター

page

unknown

反復子から IteratorResult にアクセス value する byPage オブジェクト。

戻り値

string | undefined

今後の呼び出し中に byPage() に渡すことができる継続トークン。