WorkspaceNamedValue interface
Interface representing a WorkspaceNamedValue.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, NamedValueCreateContract, WorkspaceNamedValueCreateOrUpdateOptionalParams)
Creates or updates named value.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, parameters: NamedValueCreateContract, options?: WorkspaceNamedValueCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceNamedValueCreateOrUpdateResponse>, WorkspaceNamedValueCreateOrUpdateResponse>>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.
- namedValueId
-
string
Identifier of the NamedValue.
- parameters
- NamedValueCreateContract
Create parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceNamedValueCreateOrUpdateResponse>, WorkspaceNamedValueCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, NamedValueCreateContract, WorkspaceNamedValueCreateOrUpdateOptionalParams)
Creates or updates named value.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, parameters: NamedValueCreateContract, options?: WorkspaceNamedValueCreateOrUpdateOptionalParams): Promise<WorkspaceNamedValueCreateOrUpdateResponse>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.
- namedValueId
-
string
Identifier of the NamedValue.
- parameters
- NamedValueCreateContract
Create parameters.
The options parameters.
Returns
beginRefreshSecret(string, string, string, string, WorkspaceNamedValueRefreshSecretOptionalParams)
Refresh the secret of the named value specified by its identifier.
function beginRefreshSecret(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, options?: WorkspaceNamedValueRefreshSecretOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceNamedValueRefreshSecretResponse>, WorkspaceNamedValueRefreshSecretResponse>>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.
- namedValueId
-
string
Identifier of the NamedValue.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceNamedValueRefreshSecretResponse>, WorkspaceNamedValueRefreshSecretResponse>>
beginRefreshSecretAndWait(string, string, string, string, WorkspaceNamedValueRefreshSecretOptionalParams)
Refresh the secret of the named value specified by its identifier.
function beginRefreshSecretAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, options?: WorkspaceNamedValueRefreshSecretOptionalParams): Promise<WorkspaceNamedValueRefreshSecretResponse>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.
- namedValueId
-
string
Identifier of the NamedValue.
The options parameters.
Returns
beginUpdate(string, string, string, string, string, NamedValueUpdateParameters, WorkspaceNamedValueUpdateOptionalParams)
Updates the specific named value.
function beginUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, ifMatch: string, parameters: NamedValueUpdateParameters, options?: WorkspaceNamedValueUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceNamedValueUpdateResponse>, WorkspaceNamedValueUpdateResponse>>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.
- namedValueId
-
string
Identifier of the NamedValue.
- 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.
- parameters
- NamedValueUpdateParameters
Update parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceNamedValueUpdateResponse>, WorkspaceNamedValueUpdateResponse>>
beginUpdateAndWait(string, string, string, string, string, NamedValueUpdateParameters, WorkspaceNamedValueUpdateOptionalParams)
Updates the specific named value.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, ifMatch: string, parameters: NamedValueUpdateParameters, options?: WorkspaceNamedValueUpdateOptionalParams): Promise<WorkspaceNamedValueUpdateResponse>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.
- namedValueId
-
string
Identifier of the NamedValue.
- 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.
- parameters
- NamedValueUpdateParameters
Update parameters.
The options parameters.
Returns
Promise<WorkspaceNamedValueUpdateResponse>
delete(string, string, string, string, string, WorkspaceNamedValueDeleteOptionalParams)
Deletes specific named value from the workspace in an API Management service instance.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, ifMatch: string, options?: WorkspaceNamedValueDeleteOptionalParams): 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.
- namedValueId
-
string
Identifier of the NamedValue.
- 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, WorkspaceNamedValueGetOptionalParams)
Gets the details of the named value specified by its identifier.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, options?: WorkspaceNamedValueGetOptionalParams): Promise<WorkspaceNamedValueGetResponse>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.
- namedValueId
-
string
Identifier of the NamedValue.
The options parameters.
Returns
Promise<WorkspaceNamedValueGetResponse>
getEntityTag(string, string, string, string, WorkspaceNamedValueGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the named value specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, options?: WorkspaceNamedValueGetEntityTagOptionalParams): Promise<WorkspaceNamedValueGetEntityTagHeaders>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.
- namedValueId
-
string
Identifier of the NamedValue.
The options parameters.
Returns
listByService(string, string, string, WorkspaceNamedValueListByServiceOptionalParams)
Lists a collection of named values defined within a workspace in a service instance.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceNamedValueListByServiceOptionalParams): PagedAsyncIterableIterator<NamedValueContract, NamedValueContract[], 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
listValue(string, string, string, string, WorkspaceNamedValueListValueOptionalParams)
Gets the secret of the named value specified by its identifier.
function listValue(resourceGroupName: string, serviceName: string, workspaceId: string, namedValueId: string, options?: WorkspaceNamedValueListValueOptionalParams): Promise<WorkspaceNamedValueListValueResponse>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.
- namedValueId
-
string
Identifier of the NamedValue.
The options parameters.
Returns
Promise<WorkspaceNamedValueListValueResponse>