Tag interface
タグを表すインターフェイス。
メソッド
メソッドの詳細
assignToApi(string, string, string, string, TagAssignToApiOptionalParams)
API にタグを割り当てます。
function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagAssignToApiOptionalParams
options パラメーター。
戻り値
Promise<TagAssignToApiResponse>
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)
操作にタグを割り当てます。
function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- operationId
-
string
API 内の操作識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<TagContract>
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)
製品にタグを割り当てます。
function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagAssignToProductOptionalParams
options パラメーター。
戻り値
Promise<TagContract>
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)
タグを作成します。
function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- TagCreateUpdateParameters
パラメーターを作成します。
- options
- TagCreateOrUpdateOptionalParams
options パラメーター。
戻り値
Promise<TagCreateOrUpdateResponse>
delete(string, string, string, string, TagDeleteOptionalParams)
API Management サービス インスタンスの特定のタグを削除します。
function delete(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, options?: TagDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- TagDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)
API からタグをデタッチします。
function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagDetachFromApiOptionalParams
options パラメーター。
戻り値
Promise<void>
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)
操作からタグをデタッチします。
function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- operationId
-
string
API 内の操作識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<void>
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)
製品からタグをデタッチします。
function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, TagGetOptionalParams)
識別子で指定されたタグの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagGetOptionalParams
options パラメーター。
戻り値
Promise<TagGetResponse>
getByApi(string, string, string, string, TagGetByApiOptionalParams)
API に関連付けられているタグを取得します。
function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagGetByApiOptionalParams
options パラメーター。
戻り値
Promise<TagGetByApiResponse>
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)
Operation に関連付けられているタグを取得します。
function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- operationId
-
string
API 内の操作識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagGetByOperationOptionalParams
options パラメーター。
戻り値
Promise<TagGetByOperationResponse>
getByProduct(string, string, string, string, TagGetByProductOptionalParams)
Product に関連付けられているタグを取得します。
function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagGetByProductOptionalParams
options パラメーター。
戻り値
Promise<TagGetByProductResponse>
getEntityState(string, string, string, TagGetEntityStateOptionalParams)
識別子で指定されたタグのエンティティ状態バージョンを取得します。
function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagGetEntityStateOptionalParams
options パラメーター。
戻り値
Promise<TagGetEntityStateHeaders>
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)
識別子で指定されたタグのエンティティ状態バージョンを取得します。
function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<TagGetEntityStateByApiHeaders>
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)
識別子で指定されたタグのエンティティ状態バージョンを取得します。
function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- operationId
-
string
API 内の操作識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<TagGetEntityStateByOperationHeaders>
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)
識別子で指定されたタグのエンティティ状態バージョンを取得します。
function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<TagGetEntityStateByProductHeaders>
listByApi(string, string, string, TagListByApiOptionalParams)
API に関連付けられているすべてのタグを一覧表示します。
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- options
- TagListByApiOptionalParams
options パラメーター。
戻り値
listByOperation(string, string, string, string, TagListByOperationOptionalParams)
操作に関連付けられているすべてのタグを一覧表示します。
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- operationId
-
string
API 内の操作識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagListByOperationOptionalParams
options パラメーター。
戻り値
listByProduct(string, string, string, TagListByProductOptionalParams)
製品に関連付けられているすべてのタグを一覧表示します。
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- TagListByProductOptionalParams
options パラメーター。
戻り値
listByService(string, string, TagListByServiceOptionalParams)
サービス インスタンス内で定義されているタグのコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- options
- TagListByServiceOptionalParams
options パラメーター。
戻り値
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)
識別子で指定されたタグの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- tagId
-
string
タグ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- TagCreateUpdateParameters
パラメーターを更新します。
- options
- TagUpdateOptionalParams
options パラメーター。
戻り値
Promise<TagUpdateResponse>