GatewayHostnameConfiguration | @azure/arm-apimanagement

Interface representing a GatewayHostnameConfiguration.

Hierarchy

GatewayHostnameConfiguration

Implemented by

GatewayHostnameConfigurationImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, parameters: GatewayHostnameConfigurationContract, options?: GatewayHostnameConfigurationCreateOrUpdateOptionalParams): Promise<GatewayHostnameConfigurationCreateOrUpdateResponse>

- Defined in operationsInterfaces/gatewayHostnameConfiguration.ts:85
Creates of updates hostname configuration for a Gateway.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: GatewayHostnameConfigurationCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<GatewayHostnameConfigurationCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, ifMatch: string, options?: GatewayHostnameConfigurationDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/gatewayHostnameConfiguration.ts:105
Deletes the specified hostname configuration from the specified Gateway.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: GatewayHostnameConfigurationDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetOptionalParams): Promise<GatewayHostnameConfigurationGetResponse>

- Defined in operationsInterfaces/gatewayHostnameConfiguration.ts:67
Get details of a hostname configuration

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: GatewayHostnameConfigurationGetOptionalParams
  
  The options parameters.
Returns Promise<GatewayHostnameConfigurationGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetEntityTagOptionalParams): Promise<GatewayHostnameConfigurationGetEntityTagResponse>

- Defined in operationsInterfaces/gatewayHostnameConfiguration.ts:50
Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: GatewayHostnameConfigurationGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<GatewayHostnameConfigurationGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayHostnameConfigurationListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayHostnameConfigurationContract>

- Defined in operationsInterfaces/gatewayHostnameConfiguration.ts:33
Lists the collection of hostname configurations for the specified gateway.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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'
- Optional options: GatewayHostnameConfigurationListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GatewayHostnameConfigurationContract>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

hcId: string

parameters: GatewayHostnameConfigurationContract

Optional options: GatewayHostnameConfigurationCreateOrUpdateOptionalParams

Returns Promise<GatewayHostnameConfigurationCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

hcId: string

ifMatch: string

Optional options: GatewayHostnameConfigurationDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

hcId: string

Optional options: GatewayHostnameConfigurationGetOptionalParams

Returns Promise<GatewayHostnameConfigurationGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

hcId: string

Optional options: GatewayHostnameConfigurationGetEntityTagOptionalParams

Returns Promise<GatewayHostnameConfigurationGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

Optional options: GatewayHostnameConfigurationListByServiceOptionalParams

Returns PagedAsyncIterableIterator<GatewayHostnameConfigurationContract>