GatewayHostnameConfiguration interface
GatewayHostnameConfiguration を表すインターフェイス。
メソッド
| create |
ゲートウェイの更新プログラムのホスト名構成を作成します。 |
| delete(string, string, string, string, string, Gateway |
指定したゲートウェイから、指定したホスト名構成を削除します。 |
| get(string, string, string, string, Gateway |
ホスト名構成の詳細を取得する |
| get |
識別子で指定されたホスト名構成エンティティが、指定されたゲートウェイ エンティティに存在することを確認します。 |
| list |
指定されたゲートウェイのホスト名構成のコレクションを一覧表示します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, GatewayHostnameConfigurationContract, GatewayHostnameConfigurationCreateOrUpdateOptionalParams)
ゲートウェイの更新プログラムのホスト名構成を作成します。
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, parameters: GatewayHostnameConfigurationContract, options?: GatewayHostnameConfigurationCreateOrUpdateOptionalParams): Promise<GatewayHostnameConfigurationCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
- hcId
-
string
ゲートウェイ ホスト名構成識別子。 親 Gateway エンティティのスコープで一意である必要があります。
- parameters
- GatewayHostnameConfigurationContract
ゲートウェイ ホスト名の構成の詳細。
options パラメーター。
戻り値
delete(string, string, string, string, string, GatewayHostnameConfigurationDeleteOptionalParams)
指定したゲートウェイから、指定したホスト名構成を削除します。
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, ifMatch: string, options?: GatewayHostnameConfigurationDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
- hcId
-
string
ゲートウェイ ホスト名構成識別子。 親 Gateway エンティティのスコープで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, GatewayHostnameConfigurationGetOptionalParams)
ホスト名構成の詳細を取得する
function get(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetOptionalParams): Promise<GatewayHostnameConfigurationGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
- hcId
-
string
ゲートウェイ ホスト名構成識別子。 親 Gateway エンティティのスコープで一意である必要があります。
options パラメーター。
戻り値
getEntityTag(string, string, string, string, GatewayHostnameConfigurationGetEntityTagOptionalParams)
識別子で指定されたホスト名構成エンティティが、指定されたゲートウェイ エンティティに存在することを確認します。
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetEntityTagOptionalParams): Promise<GatewayHostnameConfigurationGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
- hcId
-
string
ゲートウェイ ホスト名構成識別子。 親 Gateway エンティティのスコープで一意である必要があります。
options パラメーター。
戻り値
listByService(string, string, string, GatewayHostnameConfigurationListByServiceOptionalParams)
指定されたゲートウェイのホスト名構成のコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayHostnameConfigurationListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayHostnameConfigurationContract, GatewayHostnameConfigurationContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
options パラメーター。