JobCredentialsOperations Class
JobCredentialsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
Constructor
JobCredentialsOperations(client, config, serializer, deserializer)
Parameters
| Name | Description |
|---|---|
|
client
Required
|
Client for service requests. |
|
config
Required
|
Configuration of service client. |
|
serializer
Required
|
An object model serializer. |
|
deserializer
Required
|
An object model deserializer. |
Variables
| Name | Description |
|---|---|
|
models
|
Alias to model classes used in this operation group. |
Methods
| create_or_update |
Creates or updates a job credential. |
| delete |
Deletes a job credential. |
| get |
Gets a jobs credential. |
| list_by_agent |
Gets a list of jobs credentials. |
create_or_update
Creates or updates a job credential.
create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, parameters: '_models.JobCredential', **kwargs: Any) -> _models.JobCredential
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
|
server_name
Required
|
The name of the server. |
|
job_agent_name
Required
|
The name of the job agent. |
|
credential_name
Required
|
The name of the credential. |
|
parameters
Required
|
The requested job credential state. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
JobCredential, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a job credential.
delete(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, **kwargs: Any) -> None
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
|
server_name
Required
|
The name of the server. |
|
job_agent_name
Required
|
The name of the job agent. |
|
credential_name
Required
|
The name of the credential. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a jobs credential.
get(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, **kwargs: Any) -> _models.JobCredential
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
|
server_name
Required
|
The name of the server. |
|
job_agent_name
Required
|
The name of the job agent. |
|
credential_name
Required
|
The name of the credential. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
JobCredential, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_agent
Gets a list of jobs credentials.
list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) -> Iterable['_models.JobCredentialListResult']
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
|
server_name
Required
|
The name of the server. |
|
job_agent_name
Required
|
The name of the job agent. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either JobCredentialListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv223\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>