SecretValueOperations class
Class representing a SecretValueOperations.
Constructors
| Secret |
Create a SecretValueOperations. |
Methods
Constructor Details
SecretValueOperations(ServiceFabricMeshManagementClientContext)
Create a SecretValueOperations.
new SecretValueOperations(client: ServiceFabricMeshManagementClientContext)Parameters
Reference to the service client.
Method Details
create(string, string, string, SecretValueResourceDescription, RequestOptionsBase)
Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.
function create(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, secretValueResourceDescription: SecretValueResourceDescription, options?: RequestOptionsBase): Promise<SecretValueCreateResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- secretValueResourceDescription
- SecretValueResourceDescription
Description for creating a value of a secret resource.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<SecretValueCreateResponse>
Promise<Models.SecretValueCreateResponse>
create(string, string, string, SecretValueResourceDescription, RequestOptionsBase, ServiceCallback<SecretValueResourceDescription>)
function create(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, secretValueResourceDescription: SecretValueResourceDescription, options: RequestOptionsBase, callback: ServiceCallback<SecretValueResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- secretValueResourceDescription
- SecretValueResourceDescription
Description for creating a value of a secret resource.
- options
- RequestOptionsBase
The optional parameters
The callback
create(string, string, string, SecretValueResourceDescription, ServiceCallback<SecretValueResourceDescription>)
function create(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, secretValueResourceDescription: SecretValueResourceDescription, callback: ServiceCallback<SecretValueResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- secretValueResourceDescription
- SecretValueResourceDescription
Description for creating a value of a secret resource.
The callback
deleteMethod(string, string, string, RequestOptionsBase)
Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.
function deleteMethod(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, string, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, callback: ServiceCallback<void>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- callback
-
ServiceCallback<void>
The callback
get(string, string, string, RequestOptionsBase)
Get the information about the specified named secret value resources. The information does not include the actual value of the secret.
function get(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: RequestOptionsBase): Promise<SecretValueGetResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<SecretValueGetResponse>
Promise<Models.SecretValueGetResponse>
get(string, string, string, RequestOptionsBase, ServiceCallback<SecretValueResourceDescription>)
function get(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<SecretValueResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- options
- RequestOptionsBase
The optional parameters
The callback
get(string, string, string, ServiceCallback<SecretValueResourceDescription>)
function get(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, callback: ServiceCallback<SecretValueResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
The callback
list(string, string, RequestOptionsBase)
Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.
function list(resourceGroupName: string, secretResourceName: string, options?: RequestOptionsBase): Promise<SecretValueListResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<SecretValueListResponse>
Promise<Models.SecretValueListResponse>
list(string, string, RequestOptionsBase, ServiceCallback<SecretValueResourceDescriptionList>)
function list(resourceGroupName: string, secretResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<SecretValueResourceDescriptionList>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- options
- RequestOptionsBase
The optional parameters
The callback
list(string, string, ServiceCallback<SecretValueResourceDescriptionList>)
function list(resourceGroupName: string, secretResourceName: string, callback: ServiceCallback<SecretValueResourceDescriptionList>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
The callback
listNext(string, RequestOptionsBase)
Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.
function listNext(nextPageLink: string, options?: RequestOptionsBase): Promise<SecretValueListNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<SecretValueListNextResponse>
Promise<Models.SecretValueListNextResponse>
listNext(string, RequestOptionsBase, ServiceCallback<SecretValueResourceDescriptionList>)
function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<SecretValueResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
The callback
listNext(string, ServiceCallback<SecretValueResourceDescriptionList>)
function listNext(nextPageLink: string, callback: ServiceCallback<SecretValueResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The callback
listValue(string, string, string, RequestOptionsBase)
Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.
function listValue(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: RequestOptionsBase): Promise<SecretValueListValueResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<SecretValueListValueResponse>
Promise<Models.SecretValueListValueResponse>
listValue(string, string, string, RequestOptionsBase, ServiceCallback<SecretValue>)
function listValue(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<SecretValue>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listValue(string, string, string, ServiceCallback<SecretValue>)
function listValue(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, callback: ServiceCallback<SecretValue>)Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- callback
The callback