ApiTagDescription interface
ApiTagDescription を表すインターフェイス。
メソッド
| create |
API のスコープ内のタグの記述を作成または更新します。 |
| delete(string, string, string, string, string, Api |
API のタグの記述を削除します。 |
| get(string, string, string, string, Api |
API のスコープでタグの説明を取得する |
| get |
識別子で指定されたタグのエンティティ状態バージョンを取得します。 |
| list |
API のスコープ内のすべてのタグの記述を一覧表示します。 swagger に似たモデル - tagDescription は API レベルで定義されていますが、タグは Operations に割り当てることができます |
メソッドの詳細
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
API のスコープ内のタグの記述を作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- tagDescriptionId
-
string
タグの説明識別子。 API/タグ関連付けの tagDescription を作成するときに使用されます。 API 名とタグ名に基づく。
- parameters
- TagDescriptionCreateParameters
パラメーターを作成します。
options パラメーター。
戻り値
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
API のタグの記述を削除します。
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- tagDescriptionId
-
string
タグの説明識別子。 API/タグ関連付けの tagDescription を作成するときに使用されます。 API 名とタグ名に基づく。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
API のスコープでタグの説明を取得する
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- tagDescriptionId
-
string
タグの説明識別子。 API/タグ関連付けの tagDescription を作成するときに使用されます。 API 名とタグ名に基づく。
options パラメーター。
戻り値
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
識別子で指定されたタグのエンティティ状態バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- tagDescriptionId
-
string
タグの説明識別子。 API/タグ関連付けの tagDescription を作成するときに使用されます。 API 名とタグ名に基づく。
options パラメーター。
戻り値
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
API のスコープ内のすべてのタグの記述を一覧表示します。 swagger に似たモデル - tagDescription は API レベルで定義されていますが、タグは Operations に割り当てることができます
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
options パラメーター。