GatewayHostnameConfiguration interface
Interface representing a GatewayHostnameConfiguration.
Methods
| create |
Creates of updates hostname configuration for a Gateway. |
| delete(string, string, string, string, string, Gateway |
Deletes the specified hostname configuration from the specified Gateway. |
| get(string, string, string, string, Gateway |
Get details of a hostname configuration |
| get |
Checks that hostname configuration entity specified by identifier exists for specified Gateway entity. |
| list |
Lists the collection of hostname configurations for the specified gateway. |
Method Details
createOrUpdate(string, string, string, string, GatewayHostnameConfigurationContract, GatewayHostnameConfigurationCreateOrUpdateOptionalParams)
Creates of updates hostname configuration for a Gateway.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, parameters: GatewayHostnameConfigurationContract, options?: GatewayHostnameConfigurationCreateOrUpdateOptionalParams): Promise<GatewayHostnameConfigurationCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- gatewayId
-
string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- hcId
-
string
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
- parameters
- GatewayHostnameConfigurationContract
Gateway hostname configuration details.
The options parameters.
Returns
delete(string, string, string, string, string, GatewayHostnameConfigurationDeleteOptionalParams)
Deletes the specified hostname configuration from the specified Gateway.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, ifMatch: string, options?: GatewayHostnameConfigurationDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- gatewayId
-
string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- hcId
-
string
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, GatewayHostnameConfigurationGetOptionalParams)
Get details of a hostname configuration
function get(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetOptionalParams): Promise<GatewayHostnameConfigurationGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- gatewayId
-
string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- hcId
-
string
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
The options parameters.
Returns
getEntityTag(string, string, string, string, GatewayHostnameConfigurationGetEntityTagOptionalParams)
Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetEntityTagOptionalParams): Promise<GatewayHostnameConfigurationGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- gatewayId
-
string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- hcId
-
string
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
The options parameters.
Returns
listByService(string, string, string, GatewayHostnameConfigurationListByServiceOptionalParams)
Lists the collection of hostname configurations for the specified gateway.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayHostnameConfigurationListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayHostnameConfigurationContract, GatewayHostnameConfigurationContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- gatewayId
-
string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
The options parameters.