MeshSecret | @azure/servicefabric

Class representing a MeshSecret.

Hierarchy

MeshSecret

Index

Constructors

constructor

Methods

Constructors

constructor

new MeshSecret(client: ServiceFabricClientContext): MeshSecret

- Defined in operations/meshSecret.ts:19
Create a MeshSecret.

Parameters
- client: ServiceFabricClientContext
  
  Reference to the service client.
Returns MeshSecret

Methods

createOrUpdate

createOrUpdate(secretResourceName: string, secretResourceDescription: SecretResourceDescription, options?: msRest.RequestOptionsBase): Promise<Models.MeshSecretCreateOrUpdateResponse>
createOrUpdate(secretResourceName: string, secretResourceDescription: SecretResourceDescription, callback: msRest.ServiceCallback<SecretResourceDescription>): void
createOrUpdate(secretResourceName: string, secretResourceDescription: SecretResourceDescription, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SecretResourceDescription>): void

- Defined in operations/meshSecret.ts:39
Creates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the specified description and properties. Once created, the kind and contentType of a secret resource cannot be updated.

summary

Creates or updates a Secret resource.

Parameters
- secretResourceName: string
  
  The name of the secret resource.
- secretResourceDescription: SecretResourceDescription
  
  Description for creating a secret resource.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshSecretCreateOrUpdateResponse>

Promise<Models.MeshSecretCreateOrUpdateResponse>
- Defined in operations/meshSecret.ts:45
Parameters
- secretResourceName: string
  
  The name of the secret resource.
- secretResourceDescription: SecretResourceDescription
  
  Description for creating a secret resource.
- callback: msRest.ServiceCallback<SecretResourceDescription>
  
  The callback
Returns void
- Defined in operations/meshSecret.ts:52
Parameters
- secretResourceName: string
  
  The name of the secret resource.
- secretResourceDescription: SecretResourceDescription
  
  Description for creating a secret resource.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<SecretResourceDescription>
  
  The callback
Returns void

deleteMethod

deleteMethod(secretResourceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
deleteMethod(secretResourceName: string, callback: msRest.ServiceCallback<void>): void
deleteMethod(secretResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/meshSecret.ts:101
Deletes the specified Secret resource and all of its named values.

summary

Deletes the Secret resource.

Parameters
- secretResourceName: string
  
  The name of the secret resource.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/meshSecret.ts:106
Parameters
- secretResourceName: string
  
  The name of the secret resource.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/meshSecret.ts:112
Parameters
- secretResourceName: string
  
  The name of the secret resource.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

get

get(secretResourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.MeshSecretGetResponse>
get(secretResourceName: string, callback: msRest.ServiceCallback<SecretResourceDescription>): void
get(secretResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SecretResourceDescription>): void

- Defined in operations/meshSecret.ts:72
Gets the information about the Secret resource with the given name. The information include the description and other properties of the Secret.

summary

Gets the Secret resource with the given name.

Parameters
- secretResourceName: string
  
  The name of the secret resource.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshSecretGetResponse>

Promise<Models.MeshSecretGetResponse>
- Defined in operations/meshSecret.ts:77
Parameters
- secretResourceName: string
  
  The name of the secret resource.
- callback: msRest.ServiceCallback<SecretResourceDescription>
  
  The callback
Returns void
- Defined in operations/meshSecret.ts:83
Parameters
- secretResourceName: string
  
  The name of the secret resource.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<SecretResourceDescription>
  
  The callback
Returns void

list

list(options?: msRest.RequestOptionsBase): Promise<Models.MeshSecretListResponse>
list(callback: msRest.ServiceCallback<PagedSecretResourceDescriptionList>): void
list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PagedSecretResourceDescriptionList>): void

- Defined in operations/meshSecret.ts:130
Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.

summary

Lists all the secret resources.

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshSecretListResponse>

Promise<Models.MeshSecretListResponse>
- Defined in operations/meshSecret.ts:134
Parameters
- callback: msRest.ServiceCallback<PagedSecretResourceDescriptionList>
  
  The callback
Returns void
- Defined in operations/meshSecret.ts:139
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<PagedSecretResourceDescriptionList>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ServiceFabricClientContext

Returns MeshSecret

Methods

createOrUpdate

Parameters

secretResourceName: string

secretResourceDescription: SecretResourceDescription

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshSecretCreateOrUpdateResponse>

Parameters

secretResourceName: string

secretResourceDescription: SecretResourceDescription

callback: msRest.ServiceCallback<SecretResourceDescription>

Returns void

Parameters

secretResourceName: string

secretResourceDescription: SecretResourceDescription

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<SecretResourceDescription>

Returns void

deleteMethod

Parameters

secretResourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

Parameters

secretResourceName: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

secretResourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<void>

Returns void

get

Parameters

secretResourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshSecretGetResponse>

Parameters

secretResourceName: string

callback: msRest.ServiceCallback<SecretResourceDescription>

Returns void

Parameters

secretResourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<SecretResourceDescription>

Returns void

list

Parameters

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshSecretListResponse>

Parameters

callback: msRest.ServiceCallback<PagedSecretResourceDescriptionList>

Returns void

Parameters

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<PagedSecretResourceDescriptionList>

Returns void