WorkspaceCertificate interface
Interface representing a WorkspaceCertificate.
Methods
| create |
Creates or updates the certificate being used for authentication with the backend. |
| delete(string, string, string, string, string, Workspace |
Deletes specific certificate. |
| get(string, string, string, string, Workspace |
Gets the details of the certificate specified by its identifier. |
| get |
Gets the entity state (Etag) version of the certificate specified by its identifier. |
| list |
Lists a collection of all certificates in the specified workspace. |
| refresh |
From KeyVault, Refresh the certificate being used for authentication with the backend. |
Method Details
createOrUpdate(string, string, string, string, CertificateCreateOrUpdateParameters, WorkspaceCertificateCreateOrUpdateOptionalParams)
Creates or updates the certificate being used for authentication with the backend.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, certificateId: string, parameters: CertificateCreateOrUpdateParameters, options?: WorkspaceCertificateCreateOrUpdateOptionalParams): Promise<WorkspaceCertificateCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- certificateId
-
string
Identifier of the certificate entity. Must be unique in the current API Management service instance.
- parameters
- CertificateCreateOrUpdateParameters
Create or Update parameters.
The options parameters.
Returns
delete(string, string, string, string, string, WorkspaceCertificateDeleteOptionalParams)
Deletes specific certificate.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, certificateId: string, ifMatch: string, options?: WorkspaceCertificateDeleteOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- 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, WorkspaceCertificateGetOptionalParams)
Gets the details of the certificate specified by its identifier.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, certificateId: string, options?: WorkspaceCertificateGetOptionalParams): Promise<WorkspaceCertificateGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- certificateId
-
string
Identifier of the certificate entity. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<WorkspaceCertificateGetResponse>
getEntityTag(string, string, string, string, WorkspaceCertificateGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the certificate specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, certificateId: string, options?: WorkspaceCertificateGetEntityTagOptionalParams): Promise<WorkspaceCertificateGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- certificateId
-
string
Identifier of the certificate entity. Must be unique in the current API Management service instance.
The options parameters.
Returns
listByWorkspace(string, string, string, WorkspaceCertificateListByWorkspaceOptionalParams)
Lists a collection of all certificates in the specified workspace.
function listByWorkspace(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceCertificateListByWorkspaceOptionalParams): PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
refreshSecret(string, string, string, string, WorkspaceCertificateRefreshSecretOptionalParams)
From KeyVault, Refresh the certificate being used for authentication with the backend.
function refreshSecret(resourceGroupName: string, serviceName: string, workspaceId: string, certificateId: string, options?: WorkspaceCertificateRefreshSecretOptionalParams): Promise<WorkspaceCertificateRefreshSecretResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- certificateId
-
string
Identifier of the certificate entity. Must be unique in the current API Management service instance.
The options parameters.