GatewayCertificateAuthority | @azure/arm-apimanagement

Interface representing a GatewayCertificateAuthority.

Hierarchy

GatewayCertificateAuthority

Implemented by

GatewayCertificateAuthorityImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, certificateId: string, parameters: GatewayCertificateAuthorityContract, options?: GatewayCertificateAuthorityCreateOrUpdateOptionalParams): Promise<GatewayCertificateAuthorityCreateOrUpdateResponse>

- Defined in operationsInterfaces/gatewayCertificateAuthority.ts:84
Assign Certificate entity to Gateway entity as Certificate Authority.

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'
- certificateId: string
  
  Identifier of the certificate entity. Must be unique in the current API Management service instance.
- parameters: GatewayCertificateAuthorityContract
  
  Gateway certificate authority details.
- Optional options: GatewayCertificateAuthorityCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<GatewayCertificateAuthorityCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/gatewayCertificateAuthority.ts:104
Remove relationship between Certificate Authority and 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'
- certificateId: string
  
  Identifier of the certificate entity. Must be unique in the current API Management service instance.
- 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: GatewayCertificateAuthorityDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, gatewayId: string, certificateId: string, options?: GatewayCertificateAuthorityGetOptionalParams): Promise<GatewayCertificateAuthorityGetResponse>

- Defined in operationsInterfaces/gatewayCertificateAuthority.ts:66
Get assigned Gateway Certificate Authority details.

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'
- certificateId: string
  
  Identifier of the certificate entity. Must be unique in the current API Management service instance.
- Optional options: GatewayCertificateAuthorityGetOptionalParams
  
  The options parameters.
Returns Promise<GatewayCertificateAuthorityGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, certificateId: string, options?: GatewayCertificateAuthorityGetEntityTagOptionalParams): Promise<GatewayCertificateAuthorityGetEntityTagResponse>

- Defined in operationsInterfaces/gatewayCertificateAuthority.ts:49
Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.

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'
- certificateId: string
  
  Identifier of the certificate entity. Must be unique in the current API Management service instance.
- Optional options: GatewayCertificateAuthorityGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<GatewayCertificateAuthorityGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayCertificateAuthorityListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayCertificateAuthorityContract>

- Defined in operationsInterfaces/gatewayCertificateAuthority.ts:33
Lists the collection of Certificate Authorities for the 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'
- Optional options: GatewayCertificateAuthorityListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GatewayCertificateAuthorityContract>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

certificateId: string

parameters: GatewayCertificateAuthorityContract

Optional options: GatewayCertificateAuthorityCreateOrUpdateOptionalParams

Returns Promise<GatewayCertificateAuthorityCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

certificateId: string

ifMatch: string

Optional options: GatewayCertificateAuthorityDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

certificateId: string

Optional options: GatewayCertificateAuthorityGetOptionalParams

Returns Promise<GatewayCertificateAuthorityGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

certificateId: string

Optional options: GatewayCertificateAuthorityGetEntityTagOptionalParams

Returns Promise<GatewayCertificateAuthorityGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

Optional options: GatewayCertificateAuthorityListByServiceOptionalParams

Returns PagedAsyncIterableIterator<GatewayCertificateAuthorityContract>