GatewayCertificateAuthority interface
Interface representing a GatewayCertificateAuthority.
Methods
| create |
Assign Certificate entity to Gateway entity as Certificate Authority. |
| delete(string, string, string, string, string, Gateway |
Remove relationship between Certificate Authority and Gateway entity. |
| get(string, string, string, string, Gateway |
Get assigned Gateway Certificate Authority details. |
| get |
Checks if Certificate entity is assigned to Gateway entity as Certificate Authority. |
| list |
Lists the collection of Certificate Authorities for the specified Gateway entity. |
Method Details
createOrUpdate(string, string, string, string, GatewayCertificateAuthorityContract, GatewayCertificateAuthorityCreateOrUpdateOptionalParams)
Assign Certificate entity to Gateway entity as Certificate Authority.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, certificateId: string, parameters: GatewayCertificateAuthorityContract, options?: GatewayCertificateAuthorityCreateOrUpdateOptionalParams): Promise<GatewayCertificateAuthorityCreateOrUpdateResponse>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'
- certificateId
-
string
Identifier of the certificate entity. Must be unique in the current API Management service instance.
- parameters
- GatewayCertificateAuthorityContract
Gateway certificate authority details.
The options parameters.
Returns
delete(string, string, string, string, string, GatewayCertificateAuthorityDeleteOptionalParams)
Remove relationship between Certificate Authority and Gateway entity.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, certificateId: string, ifMatch: string, options?: GatewayCertificateAuthorityDeleteOptionalParams): 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'
- 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.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, GatewayCertificateAuthorityGetOptionalParams)
Get assigned Gateway Certificate Authority details.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, certificateId: string, options?: GatewayCertificateAuthorityGetOptionalParams): Promise<GatewayCertificateAuthorityGetResponse>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'
- certificateId
-
string
Identifier of the certificate entity. Must be unique in the current API Management service instance.
The options parameters.
Returns
getEntityTag(string, string, string, string, GatewayCertificateAuthorityGetEntityTagOptionalParams)
Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, certificateId: string, options?: GatewayCertificateAuthorityGetEntityTagOptionalParams): Promise<GatewayCertificateAuthorityGetEntityTagHeaders>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'
- certificateId
-
string
Identifier of the certificate entity. Must be unique in the current API Management service instance.
The options parameters.
Returns
listByService(string, string, string, GatewayCertificateAuthorityListByServiceOptionalParams)
Lists the collection of Certificate Authorities for the specified Gateway entity.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayCertificateAuthorityListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayCertificateAuthorityContract, GatewayCertificateAuthorityContract[], 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.